/*
 * Microsoft .NET  2.0+ version of Sphinx searchd client (Sphinx API)
 * 
 * Copyright (c) 2009, Shaun Berryman
 * All rights reserved
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License. You should have
 * received a copy of the GPL license along with this program; if you
 * did not, you can find it at http://www.gnu.org/
 */

using System;
using System.Collections.Generic;
using System.Text;

namespace SphinxSearchApi.Model
{
    public class WordInfo
    {
        /// <summary>
        /// Word form as returned from search daemon, stemmed or otherwise postprocessed.
        /// </summary>
        public string Word;

        /// <summary>
        /// Total amount of matching documents in collection.
        /// </summary>
        public long Docs;

        /// <summary>
        /// Total amount of hits (occurences) in collection.
        /// </summary>
        public long Hits;

        /// <summary>
        /// Trivial constructor.
        /// </summary>
        /// <param name="word"></param>
        /// <param name="docs"></param>
        /// <param name="hits"></param>
        public WordInfo(string word, long docs, long hits)
        {
            this.Word = word;
            this.Docs = docs;
            this.Hits = hits;
        }
    }
}
